chore:update terminal session documentation #578
Conversation
Sumabhat11
added
good first issue
WalkthroughA new "Sessions" section was added to the Terminal documentation describing multi-session support, background execution, crash-safe behavior, usage steps (create, switch, close), and operational notes; the PR is documentation-only and contains no code changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🔇 Additional comments (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/terminal/index.md (1)
98-121: Sessions documentation is well-structured; consider minor clarifications on session persistence semantics.The Sessions feature section is clearly written and follows the documentation structure well. The getting-started steps are concrete and actionable. However, a few details could be strengthened:
Line 119 ("Sessions stick to the current environment or VPS target"): The phrasing is slightly ambiguous. Clarify whether this means sessions are environment-scoped, or if a session can be reconnected from different environments.
Line 120 (idle reclamation): This is important operational information that could affect user workflows, but it's tucked in the notes. Consider elevating this or providing more detail about the timeout policy (e.g., "idle after X minutes").
Verify feature claims: Ensure the documented behaviors (auto-reconnect after page reloads, background execution, crash-safe reattachment) match the actual implementation, as these are strong reliability guarantees.
Consider minor clarifications:
- Rephrase line 119 to be more explicit, for example: "Each session is tied to its target environment or VPS; reconnecting from a different environment creates a new session."
- Expand line 120 with an example: "Idle sessions may be reclaimed automatically after [time period] based on server policy; consider saving important context before stepping away."
|
@zhravan can you review this? |
docs/terminal/index.md
Outdated
| What sessions enable: | ||
|
|
||
| * Multiple concurrent terminals: Create, name, and jump between sessions without losing shell state. | ||
| * Auto-reconnect: The UI re-attaches to the last active session after page reloads or short disconnects. |
There was a problem hiding this comment.
Right now we do not do auto-recoonect to last session, upon refresh, you would see new connection established.
This is a good point to note, we should consider this as an improvement, with flag control for how terminals should behave. Please consider this as enhancement.
This wont be applicable for current state of terminal implementation at least.
docs/terminal/index.md
Outdated
| Getting started: | ||
|
|
||
| 1. Create a session: Opening the terminal automatically starts a session; use the session menu to spin up more. | ||
| 2. Rename a session: Give each session a descriptive name (for example `deploy` or `logs`) from the session menu. |
There was a problem hiding this comment.
This also is something we current dont support
docs/terminal/index.md
Outdated
|
|
||
| What sessions enable: | ||
|
|
||
| * Multiple concurrent terminals: Create, name, and jump between sessions without losing shell state. |
3 participants
Description
Adds terminal session documentation
Scope of Change
Select all applicable areas impacted by this PR:
Developer Checklist
To be completed by the developer who raised the PR.
Reviewer Checklist
To be completed by the reviewer before merge.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.